Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Approve confirmation dialog #2096

Merged
merged 2 commits into from
Feb 19, 2024
Merged

Approve confirmation dialog #2096

merged 2 commits into from
Feb 19, 2024

Conversation

Omri-Levy
Copy link
Contributor

@Omri-Levy Omri-Levy commented Feb 19, 2024

User description

Description

Changed the approve actions in the backoffice into a confirmation dialog.
image


Type

enhancement


Description

  • Introduced a confirmation dialog for approval actions across various components using MotionButton.
  • Simplified type definitions for DialogProps in Dialog component.
  • Enhanced user experience by requiring confirmation before proceeding with approval actions, ensuring intentional user decisions.

Changes walkthrough

Relevant files
Enhancement
Dialog.tsx
Simplify DialogProps Type Definitions                                       

apps/backoffice-v2/src/common/components/molecules/Dialog/Dialog.tsx

  • Simplified the type definitions for DialogProps properties.
+6/-6     
useKycBlock.tsx
Implement Approval Confirmation Dialog in KYC Block           

apps/backoffice-v2/src/lib/blocks/components/KycBlock/hooks/useKycBlock/useKycBlock.tsx

  • Introduced MotionButton for the approve action within a confirmation
    dialog.
  • Changed the approve action to a dialog type with a confirmation step.
  • Updated the results array type to a more concise syntax.
  • +33/-8   
    useDirectorsBlocks.tsx
    Add Approval Confirmation Dialog for Directors                     

    apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsBlocks/useDirectorsBlocks.tsx

  • Added MotionButton for the approve action within a confirmation
    dialog.
  • Changed the approve action to a dialog type with a confirmation step.
  • Added logic to disable the approve button based on specific
    conditions.
  • +42/-10 
    useDocumentBlocks.tsx
    Implement Approval Confirmation Dialog in Document Blocks

    apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/useDocumentBlocks.tsx

  • Introduced MotionButton for the approve action within a confirmation
    dialog.
  • Changed the approve action to a dialog type with a confirmation step.
  • +38/-9   

    ✨ Usage guide:

    Overview:
    The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

    /describe --pr_description.some_config1=... --pr_description.some_config2=...
    

    With a configuration file, use the following template:

    [pr_description]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation
    • When you first install the app, the default mode for the describe tool is:
    pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                             "--pr_description.keep_original_user_title=true", ...]
    

    meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.

    • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
    pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
    

    the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following:

    • type: the PR type.
    • summary: the PR summary.
    • walkthrough: the PR walkthrough.

    Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

    Custom labels

    The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other].

    If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
    Examples for custom labels:

    • Main topic:performance - pr_agent:The main topic of this PR is performance
    • New endpoint - pr_agent:A new endpoint was added in this PR
    • SQL query - pr_agent:A new SQL query was added in this PR
    • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
    • ...

    The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
    Note that Labels are not mutually exclusive, so you can add multiple label categories.
    Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

    Inline File Walkthrough 💎

    For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page.
    This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).

    To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are:

    • 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.
    • true: A collapsable file comment with changes title and a changes summary for each file in the PR.
    • false (default): File changes walkthrough will be added only to the "Conversation" tab.
    Utilizing extra instructions

    The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.

    Examples for extra instructions:

    [pr_description] 
    extra_instructions="""
    - The PR title should be in the format: '<PR type>: <title>'
    - The title should be short and concise (up to 10 words)
    - ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the describe usage page for a comprehensive guide on using this tool.

    Copy link

    changeset-bot bot commented Feb 19, 2024

    ⚠️ No Changeset found

    Latest commit: 798f2fe

    Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

    This PR includes no changesets

    When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

    Click here to learn what changesets are, and how to add one.

    Click here if you're a maintainer who wants to add a changeset to this PR

    @github-actions github-actions bot added the enhancement New feature or request label Feb 19, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (2a42709)

    Copy link
    Contributor

    github-actions bot commented Feb 19, 2024

    PR Review

    (Review updated until commit 798f2fe)

         PR feedback                    
    ⏱️ Estimated effort to review [1-5]

    3, because the changes involve both UI component adjustments and logic for handling approval actions across multiple components. Understanding the context and ensuring the changes do not introduce regressions requires a moderate amount of effort.

    🧪 Relevant tests

    No

    🔍 Possible issues
    • The motionButtonProps are reused across different components without customization, which might not fit all use cases or UI contexts.
    • The className: 'mb-96' for content might introduce excessive margin in some dialogs, potentially affecting the UI negatively.
    • The repeated pattern of dialog creation for approval actions suggests a potential for abstraction to reduce redundancy and improve maintainability.
    🔒 Security concerns

    No

    Code feedback:
    relevant fileapps/backoffice-v2/src/lib/blocks/components/KycBlock/hooks/useKycBlock/useKycBlock.tsx
    suggestion      

    Consider abstracting the dialog creation logic into a reusable function or component since the pattern is repeated across multiple components. This will improve code maintainability and readability. [important]

    relevant linetype: 'dialog',

    relevant fileapps/backoffice-v2/src/lib/blocks/hooks/useDirectorsBlocks/useDirectorsBlocks.tsx
    suggestion      

    Evaluate the necessity of the className: 'mb-96' for dialog content. If the large margin is not required in all instances, consider making it customizable through props. [medium]

    relevant lineclassName: 'mb-96',

    relevant fileapps/backoffice-v2/src/common/components/molecules/Dialog/Dialog.tsx
    suggestion      

    Instead of changing Array<ReactNode> to ReactNode | ReactNode[], consider using ReactNode alone as it already includes ReactNode[] in its type definition, simplifying the type annotations. [medium]

    relevant linetrigger: ReactNode | ReactNode[];

    relevant fileapps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/useDocumentBlocks.tsx
    suggestion      

    For consistency and to avoid potential future bugs, ensure that all buttons within dialogs have type checking for their onClick handlers, especially when they perform significant actions like approval. [important]

    relevant lineonClick={onMutateApproveTaskById({


    ✨ Usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
    When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    

    With a configuration file, use the following template:

    [pr_reviewer]
    some_config1=...
    some_config2=...
    
    Utilizing extra instructions

    The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

    Examples for extra instructions:

    [pr_reviewer] # /review #
    extra_instructions="""
    In the 'possible issues' section, emphasize the following:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    How to enable\disable automation
    • When you first install PR-Agent app, the default mode for the review tool is:
    pr_commands = ["/review", ...]
    

    meaning the review tool will run automatically on every PR, with the default configuration.
    Edit this field to enable/disable the tool, or to change the used configurations

    Auto-labels

    The review tool can auto-generate two specific types of labels for a PR:

    • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
    • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
    Extra sub-tools

    The review tool provides a collection of possible feedbacks about a PR.
    It is recommended to review the possible options, and choose the ones relevant for your use case.
    Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
    require_score_review, require_soc2_ticket, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve
    

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
    enable_auto_approval = true
    

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
    maximal_review_effort = 5
    
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    github-actions bot commented Feb 19, 2024

    PR Code Suggestions

    Suggestions                                                                                                                                                     
    enhancement
    Simplify the type definitions in the DialogProps interface.     

    Consider using a more specific type than ReactNode | ReactNode[] for the DialogProps
    interface properties. If the intent is to allow a single React node or an array of nodes,
    ReactNode alone is sufficient as it already includes arrays of nodes.

    apps/backoffice-v2/src/common/components/molecules/Dialog/Dialog.tsx [14-19]

    -trigger: ReactNode | ReactNode[];
    -content: ReactNode | ReactNode[];
    -title?: ReactNode | ReactNode[];
    -description?: ReactNode | ReactNode[];
    -footer?: ReactNode | ReactNode[];
    -close?: ReactNode | ReactNode[];
    +trigger: ReactNode;
    +content: ReactNode;
    +title?: ReactNode;
    +description?: ReactNode;
    +footer?: ReactNode;
    +close?: ReactNode;
     
    maintainability
    Use context-specific props instead of generic imports for clarity.           

    Avoid using generic names like motionButtonProps imported from useAssociatedCompaniesBlock
    across different components. Define or import props specific to the context of useKycBlock
    to ensure clarity and maintainability.

    apps/backoffice-v2/src/lib/blocks/components/KycBlock/hooks/useKycBlock/useKycBlock.tsx [25]

    -import { motionButtonProps } from '@/lib/blocks/hooks/useAssosciatedCompaniesBlock/useAssociatedCompaniesBlock';
    +import { kycBlockMotionButtonProps } from './motionButtonProps';
     
    Refactor repeated approval dialogues into a reusable component.              

    Replace the repeated logic for creating approval dialogues with a reusable component or
    function. This will reduce duplication and improve maintainability.

    apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsBlocks/useDirectorsBlocks.tsx [251-288]

    -type: 'dialog',
    -value: {
    -  trigger: (
    -    <MotionButton
    -      {...motionButtonProps}
    -      disabled={isApproveDisabled}
    -      size={'wide'}
    -      variant={'success'}
    -    >
    -      Approve
    -    </MotionButton>
    -  ),
    -  title: `Approval confirmation`,
    -  description: <p className={`text-sm`}>Are you sure you want to approve?</p>,
    -  close: (
    -    <div className={`space-x-2`}>
    -      <Button type={'button'} variant={`secondary`}>
    -        Cancel
    -      </Button>
    -      <Button
    -        disabled={isApproveDisabled}
    -        onClick={onMutateApproveTaskById({
    -          taskId: document.id,
    -          contextUpdateMethod: 'director',
    -        })}
    -      >
    -        Approve
    -      </Button>
    -    </div>
    -  ),
    -  props: {
    -    content: {
    -      className: 'mb-96',
    -    },
    -    title: {
    -      className: `text-2xl`,
    -    },
    -  },
    -},
    +<ApprovalDialog
    +  isDisabled={isApproveDisabled}
    +  onApprove={() => onMutateApproveTaskById({
    +    taskId: document.id,
    +    contextUpdateMethod: 'director',
    +  })}
    +/>
     
    Remove unused import to clean up the code.                                   

    Remove the unused mock workflow import _workflow to clean up the code and avoid confusion.

    apps/backoffice-v2/src/lib/blocks/variants/DefaultBlocks/hooks/useDefaultBlocksLogic/useDefaultBlocksLogic.tsx [44]

    -import { workflow as _workflow } from '../../../../../../pages/Entity/hooks/useEntityLogic/mock-workflow-with-children';
    +// Removed unused import
     
    best practice
    Ensure motionButtonProps are contextually appropriate for use in useDocumentBlocks.

    For consistency and to avoid potential future bugs, ensure that the motionButtonProps used
    across different components are either universally applicable or specifically tailored for
    each use case. If the latter, consider defining them within the respective component's
    scope.

    apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/useDocumentBlocks.tsx [31]

    -import { motionButtonProps } from '@/lib/blocks/hooks/useAssosciatedCompaniesBlock/useAssociatedCompaniesBlock';
    +// Define or import motionButtonProps specific to useDocumentBlocks context
    +import { documentBlockMotionButtonProps } from './motionButtonProps';
     

    ✨ Usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    @chesterkmr chesterkmr self-requested a review February 19, 2024 12:03
    Copy link
    Contributor

    PR Description updated to latest commit (798f2fe)

    Copy link
    Contributor

    Persistent review updated to latest commit 798f2fe

    Copy link
    Contributor

    github-actions bot commented Feb 19, 2024

    PR Code Suggestions

    Suggestions                                                                                                                                                     
    enhancement
    Simplify the type definitions for DialogProps properties.                    

    Consider using a more specific type than ReactNode | ReactNode[] for the properties of
    DialogProps. If the intent is to allow a single React node or an array of nodes, ReactNode
    alone is sufficient as it already includes arrays of nodes.

    apps/backoffice-v2/src/common/components/molecules/Dialog/Dialog.tsx [14-19]

    -trigger: ReactNode | ReactNode[];
    -content: ReactNode | ReactNode[];
    -title?: ReactNode | ReactNode[];
    -description?: ReactNode | ReactNode[];
    -footer?: ReactNode | ReactNode[];
    -close?: ReactNode | ReactNode[];
    +trigger: ReactNode;
    +content: ReactNode;
    +title?: ReactNode;
    +description?: ReactNode;
    +footer?: ReactNode;
    +close?: ReactNode;
     
    Create a separate component for the approval confirmation dialog.            

    To improve the maintainability and reusability of the code, consider creating a separate
    component for the approval confirmation dialog. This approach will help in managing the
    dialog's layout and behavior centrally, especially since similar patterns are observed
    across multiple hooks.

    apps/backoffice-v2/src/lib/blocks/hooks/useDocumentBlocks/useDocumentBlocks.tsx [260-287]

    -trigger: (
    -  <MotionButton
    -    {...motionButtonProps}
    -    disabled={!canApprove}
    -    size={'wide'}
    -    variant={'success'}
    -  >
    -    Approve
    -  </MotionButton>
    -),
    -title: `Approval confirmation`,
    -description: <p className={`text-sm`}>Are you sure you want to approve?</p>,
    -close: (
    -  <div className={`space-x-2`}>
    -    <Button type={'button'} variant={`secondary`}>
    -      Cancel
    -    </Button>
    -    <Button
    -      disabled={!canApprove}
    -      onClick={onMutateApproveTaskById({
    -        taskId: id,
    -        contextUpdateMethod: 'base',
    -      })}
    -    >
    -      Approve
    -    </Button>
    -  </div>
    -),
    +trigger: <ApprovalConfirmationDialog canApprove={canApprove} onApprove={() => onMutateApproveTaskById({taskId: id, contextUpdateMethod: 'base'})} />
     
    maintainability
    Define or import motionButtonProps more appropriately in useKycBlock.

    Avoid using generic names like motionButtonProps imported from useAssociatedCompaniesBlock
    in useKycBlock. This can lead to confusion and maintenance issues. Consider defining
    motionButtonProps within useKycBlock itself or creating a shared utility if the properties
    are common across different components.

    apps/backoffice-v2/src/lib/blocks/components/KycBlock/hooks/useKycBlock/useKycBlock.tsx [25]

    -import { motionButtonProps } from '@/lib/blocks/hooks/useAssosciatedCompaniesBlock/useAssociatedCompaniesBlock';
    +// Define motionButtonProps specific to useKycBlock or import from a shared utility file
    +const motionButtonProps = { ... };
     
    best practice
    Use template literals for dynamic class names in dialog properties.          

    It's recommended to use template literals for dynamic class names for consistency and
    readability. This change applies to the className properties within the dialog's content
    and title.

    apps/backoffice-v2/src/lib/blocks/hooks/useDirectorsBlocks/useDirectorsBlocks.tsx [283-286]

    -className: 'mb-96',
    +className: `mb-96`,
     className: `text-2xl`,
     

    ✨ Usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    @Omri-Levy Omri-Levy merged commit 80ee5b5 into dev Feb 19, 2024
    10 checks passed
    @Omri-Levy Omri-Levy deleted the bal-372 branch February 19, 2024 12:09
    alonp99 added a commit that referenced this pull request Feb 19, 2024
    * feat: empty checkbox in filter by (#2049)
    
    * feat: temporarily removed all sort by options except created at (#2051)
    
    * Backoffice grouping navbar (#2052)
    
    * refactor(backoffice-v2): backoffice navigation can now handle filter grouping
    
    * fix(backoffice-v2): small lint and ts fixes
    
    * fix(backoffice-v2): fixed default open state on nav items and active state
    
    * fix(backoffice-v2): fixed cases list width and height issues
    
    * refactor(backoffice-v2): addressed PR comments
    
    * seed update - images (#2057)
    
    * chore(seed): image update
    
    * Update seed.ts
    
    * feat: added customerName as interpolation in translations
    
    * feat: added new collection flow texts
    
    * feat: small ui fixes
    
    * feat: added chinese translations
    
    * feat: version bump
    
    * feat: test fix
    
    * Update docker-compose.yml (#2007)
    
    * Update docker-compose.yml
    
    * Update docker-compose.yml
    
    * fix(blocks-package): omri-levy/fix/blocks-types
    
    * [docs] update ballerine installation on aws
    
    * add: automation shell script to deploy ballerine (#1990)
    
    * add: automation shell script to deploy ballerine
    
    * Update boot.sh
    
    * Update boot.sh
    
    * Update boot.sh
    
    ---------
    
    Co-authored-by: Alon Peretz <[email protected]>
    
    * fix(kyb-app): no longer failing build due to implicit any (#2085)
    
    * Create pr_agent.yml
    
    * remove branch name (#2083)
    
    Co-authored-by: Alon Peretz <[email protected]>
    
    * Approve confirmation dialog (#2096)
    
    * feat(backoffice-v2): approve functionality is now inside a confirmation dialog
    
    * revert(usedefaultblockslogic): removed instance of mock workflow
    
    ---------
    
    Co-authored-by: Omri Levy <[email protected]>
    Co-authored-by: Alon Peretz <[email protected]>
    Co-authored-by: pratapalakshmi <[email protected]>
    Co-authored-by: Pratapa Lakshmi <[email protected]>
    @Omri-Levy Omri-Levy mentioned this pull request Nov 4, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants